ESIP Badge Design

This is the initial round of possible badges for the ESIP community. The structure and styles are based on the shields.io project (public domain) and a de facto standard for Github badging.

We have two collections, one for getting at ESIP funded things and one for the relationship to ESIP. For funding, the tags are Funded, FUNding Friday and Testbed. For the relationships, it's Member and Collaborator.

To see the designs, please go to the Examples] section.

The API is very simple. There's a single URL with the structure:

http://badge.esipfed.org/{badge-type}.svg?style={display-style}&display={diplay-option}

OR

http://badge.esipfed.org/{user}/{repository}/{badge-type}.svg?style={display-style}&display={diplay-option}

where funded is one of the supported badge types, user is the Github account and repository is the repository name.

Using it in one's documentation is as simple as adding:

<img src="http://badge.esipfed.org/funded.svg">

to the Markdown (as an img element or through another available SVG rendering method).

That method will only render the image without any links. To include a link to the ESIP site, use:

<a href="http://esipfed.org">![](http://badge.esipfed.org/roomthily/esip_badger/funded.svg)</a>

modifying the SVG request as necessary. That displays as: ![](http://badge.esipfed.org/roomthily/esip_badger/funded.svg)

The display query parameter provides the option to display the ESIP logo on the left side:

<img src="http://badge.esipfed.org/funded.svg?display=logo">

generating: ![](http://badge.esipfed.org/funded.svg?display=logo)

Parameter Options

badge-type: funded | testbed | fundingfriday | member | collaborator

display-style: flat-round (default) | plastic | flat-square

display-option: logo | text (default)

user: Github user name

repository: repository name

account and repo are accepted for basic analytic purposes only, ex:

http://badge.esipfed.org/roomthily/esip_badger/fundingfriday.svg

Text Examples

Rounded Plastic Flat

Logo Examples

Rounded Plastic Flat

Notes

It is not pixel-perfect compared to the shields.io badges (server-side python estimation without typeface info).


In [ ]: